home *** CD-ROM | disk | FTP | other *** search
/ Garbo / Garbo.cdr / mac / arcers / sitrep2.sit / SitRep doc. (TEXT) < prev    next >
Text File  |  1990-10-14  |  6KB  |  112 lines
  1.  
  2. SitReport 2.0
  3.  
  4. ⌐1989-90 Sven Axelsson
  5.  
  6. Document date: 11 Oct 1990
  7.  
  8.  
  9.  
  10.  
  11. So, finally, here is the long promised version 2 of SitReport. From what I╒ve seen on 
  12. various servers, it appears as if I have waited too long to finish it. There are now 
  13. several other programs that provide the same facilities and more. Still, they usually 
  14. are shareware and SitReport is free, as long as you do not sell it or alter it in any way.
  15.  
  16.  
  17. What does it do?
  18. This program is a utility to be used in conjunction with StuffIt 1.5.1 (and earlier), 
  19. nowdays known as StuffIt Classic. It also works with StuffIt Deluxe, although it 
  20. probably isn╒t as useful with this program since the functionality it provides is 
  21. already included in StuffIt Deluxe.
  22. As you all know, StuffIt has a facility for producing a report with some information 
  23. on the contents of an archive, and save that to a text file. In the shareware version of 
  24. StuffIt this function is severly limited in that it only reports the top-level items in 
  25. the archive. This makes the report useless with hierarchical archives, which 
  26. normally contains just a single folder as top-level item. Enter SitReport ╤ the report 
  27. generator for StuffIt archives!
  28. SitReport produces a quite comprehensive report including file/folder hiearchy, sizes 
  29. of data/resource forks, compression methods etc. The report can be saved to a text 
  30. file or printed out directly from the program.
  31.  
  32. How does it work?
  33. When you choose File Open Archive... and select the archive file of your choice, 
  34. you╒ll get a report similar to this one displayed in a window:
  35.  
  36. Contents of the StuffIt archive ╥SitRep2.sit╙.
  37.  
  38. Archive size is 546366 bytes including header info in 1 top-level file.
  39.  
  40. Archive comment:
  41.   This is a comment.
  42.  
  43. File/Folder name     Type  Crea  Data Len  %Saved  Data Method  Rsrc Len  %Saved  Rsrc Method
  44. ================     ====  ====  ========  ======  ===========  ========  ======  ===========
  45. SitRep 2 ─:
  46.   libs:
  47.     UpdCrc.lib       LIB   KAHL         0      0%  None             1146      5%  RLE        
  48.   SitRep.Build.╣     QPRJ  PJMM         0      0%  None           405986     45%  Huffman    
  49.   SitRep.╣           QPRJ  PJMM         0      0%  None           446639     43%  Huffman    
  50.   SitRep.╣.rsrc      rsrc  RSED         0      0%  None             4233     28%  Huffman    
  51.   SitReport          APPL  SITR         0      0%  None            56034     32%  Huffman    
  52.   src:
  53.     AboutBox.p       TEXT  PJMM       630     41%  Huffman             0      0%  None       
  54.     CSitRepApp.p     TEXT  PJMM      2310     64%  Huffman           594     58%  Huffman    
  55.     CSitRepDoc.p     TEXT  PJMM      5175     60%  Huffman           594     63%  Huffman    
  56.     CSitRepFile.p    TEXT  PJMM     11035     60%  Huffman             0      0%  None       
  57.     CSitRepPane.p    TEXT  PJMM      2354     57%  Huffman           594     53%  Huffman    
  58.     SitRep.p         TEXT  PJMM       588     46%  Huffman           594     56%  Huffman    
  59.     SitRepIntf.p     TEXT  PJMM      4408     56%  Huffman             0      0%  None       
  60.     UpdCrc.c         TEXT  KAHL      2965     57%  Huffman             0      0%  None       
  61.     UpdCrcIntf.p     TEXT  PJMM       534     48%  Huffman             0      0%  None       
  62.   UpdCrc.╣           PROJ  KAHL         0      0%  None             6906     30%  Huffman    
  63.  
  64.  
  65. Total unpacked size for this archive is 953319 bytes in a total of 15 files.
  66. This makes for a total saving of 43 percent.
  67. The different items in the report are as follows:
  68. Ñ    The archive size is the size of the actual file as stored on disk.
  69. Ñ    The archive comment is the comment you can attach to a StuffIt archive by 
  70. selecting the rightmost button (the balloon) in the main display.
  71. Ñ    The files and folders are displayed with their full names and indented to show the 
  72. hierarchy. They are actually alloted much more space than in the figure above, so 
  73. even long names should fit in the display, even in deeply nested folders.
  74. Ñ    Type and creator have their usual meaning.
  75. Ñ    The sizes displayed for data and resource forks are the unpacked sizes, and the 
  76. ╥%Saved╙ field shows how much space the compression has saved you.
  77. Ñ    The data- and resource method fields shows how that particular part has been 
  78. compressed, and can be one of None, RLE (Run Length Encoding), Huffman, or 
  79. Lempel-Ziv Welch.
  80. Ñ    Finally the total unpacked size for all files, the number of files in the archive, and 
  81. the total percentage of space saved is displayed.
  82.  
  83. Features:
  84. The creator for the saved file is preset as ╒ttxt╒ (TechText). If you don╒t like this, it can 
  85. easily be fixed with the aid of ResEdit or a similar utility. The creator signature is 
  86. stored in a ╒STR ╒-resource named ╙Filetype╙ (ID 1000). Just remember that this string 
  87. must contain EXCACTLY four (4) characters.
  88. Limitations:
  89. Since the program uses TextEdit to display the text, it cannot handle reports longer 
  90. than 32,000 characters. HOWEVER; even though what you see on the screen and 
  91. what can be printed might be truncated, the full text for any size report will be put 
  92. into a file when you select File Save Report... 
  93. And of course it could have been fancier in all respects etc. etc. :^)
  94.  
  95. Who am I?
  96. If you would like to contact me for any reason, such as telling me what a nice person 
  97. I am, inviting me out to dinner, or even (God forbid) reporting bugs, this is where 
  98. you can reach me.
  99. By the way, this program is mine, put together in my spare time, and has no 
  100. association whatsoever with Microsoft. I just happen to work there ╤ Microsoft 
  101. International Product Group that is ╤ Europe, not Redmond.
  102. email:    uunet!microsoft!svenax
  103. snailmail:    Sven Axelsson
  104.         4 Corrig Avenue, Flat 1
  105.         D£n Laoghaire
  106.         Republic of Ireland
  107.  
  108. Legalities
  109. StuffIt, StuffIt Classic, and StuffIt Deluxe are copyrighted programs by Aladdin 
  110. Software.
  111. SitReport is copyrighted by myself. The usual legal disclaimers apply.
  112.